<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>plugins.pluginclass</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="plugins-module.html">Package&nbsp;plugins</a> ::
        Module&nbsp;pluginclass
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="plugins.pluginclass-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="plugins.pluginclass-module.html">Module plugins.pluginclass</a></h1>
<pre class="py-src">
<a name="Plugin"></a><div id="Plugin-def"><a name="L1"></a><tt class="py-lineno">  1</tt> <a class="py-toggle" href="#" id="Plugin-toggle" onclick="return toggle('Plugin');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html">Plugin</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Plugin-expanded"><a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-docstring">    The Plugin class, all plugins should be subclassed from this. It also provides an interface.</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar callbacks  : All callbacks registered by the plugin.</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar commands   : All chatcommands registered by the plugin</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar dispatchers: All dispatchers registered by the plugin</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring">    @type callbacks  : dict</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring">    @type commands   : dict</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring">    @type dispatchers: dict</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line">    <tt id="link-0" class="py-name" targets="Variable plugins.pluginclass.Plugin.callbacks=plugins.pluginclass.Plugin-class.html#callbacks"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-0', 'callbacks', 'link-0');">callbacks</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line">    <tt id="link-1" class="py-name" targets="Variable plugins.pluginclass.Plugin.commands=plugins.pluginclass.Plugin-class.html#commands"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-1', 'commands', 'link-1');">commands</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line">    <tt id="link-2" class="py-name" targets="Variable plugins.pluginclass.Plugin.dispatchers=plugins.pluginclass.Plugin-class.html#dispatchers"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-2', 'dispatchers', 'link-2');">dispatchers</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="Plugin.__init__"></a><div id="Plugin.__init__-def"><a name="L14"></a><tt class="py-lineno"> 14</tt> <a class="py-toggle" href="#" id="Plugin.__init__-toggle" onclick="return toggle('Plugin.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">parentclient</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.__init__-expanded"><a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">        plugin constructor, please do not overwrite, but use init.</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">        @type  parentclient: SpectatorClient class instance</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">        @param parentclient: the client that is using the plugin</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Module openttd.client=openttd.client-module.html"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-3', 'client', 'link-3');">client</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parentclient</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line">            <tt class="py-name">function</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method plugins.rcon.RconPlugin.init()=plugins.rcon.RconPlugin-class.html#init,Method plugins.sample.Sample.init()=plugins.sample.Sample-class.html#init,Method plugins.stats.StatsWriter.init()=plugins.stats.StatsWriter-class.html#init,Method plugins.stats.WebServer.init()=plugins.stats.WebServer-class.html#init,Method plugins.timewarning.TimeWarning.init()=plugins.timewarning.TimeWarning-class.html#init,Method plugins.webserver.StatsWriter.init()=plugins.webserver.StatsWriter-class.html#init,Method plugins.webserver.WebServer.init()=plugins.webserver.WebServer-class.html#init"><a title="plugins.rcon.RconPlugin.init
plugins.sample.Sample.init
plugins.stats.StatsWriter.init
plugins.stats.WebServer.init
plugins.timewarning.TimeWarning.init
plugins.webserver.StatsWriter.init
plugins.webserver.WebServer.init" class="py-name" href="#" onclick="return doclink('link-4', 'init', 'link-4');">init</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line">            <tt class="py-keyword">pass</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line">            <tt class="py-name">function</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="Plugin.registerCallback"></a><div id="Plugin.registerCallback-def"><a name="L27"></a><tt class="py-lineno"> 27</tt> <a class="py-toggle" href="#" id="Plugin.registerCallback-toggle" onclick="return toggle('Plugin.registerCallback');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#registerCallback">registerCallback</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.registerCallback-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.registerCallback-expanded"><a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">        Method to register a callback. The callbacks are documented in README.txt.</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">        @type      type: string</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">        @param     type: the callback type. I.e. on_mainloop</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">        @type  callback: function</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">        @param callback: The callback</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          boolean</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if the callback was added</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:  plugin.client must not be none</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-5', 'client', 'link-3');">client</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-6" class="py-name" targets="Variable ottd_client_event.IRCChat.type=ottd_client_event.IRCChat-class.html#type"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-6', 'type', 'link-6');">type</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-7', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-8', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-9" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-9', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-10" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-10', 'type', 'link-6');">type</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-11', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-12', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-13', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-14', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-15" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-15', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-16', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-17', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-18" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-18', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-19', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-20" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-20', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterCallback"></a><div id="Plugin.unregisterCallback-def"><a name="L48"></a><tt class="py-lineno"> 48</tt> <a class="py-toggle" href="#" id="Plugin.unregisterCallback-toggle" onclick="return toggle('Plugin.unregisterCallback');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterCallback">unregisterCallback</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterCallback-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterCallback-expanded"><a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">        Method to unregister a callback. The callbacks are documented in README.txt</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">        @type      type: string</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">        @param     type: the callback type. I.e. on_mainloop</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">        @type  callback: function</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">        @param callback: The callback</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          Boolean</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if it was unregistered</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:  plugin.client must not be none</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:  the callback must be registered</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-21', 'client', 'link-3');">client</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-22" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-22', 'type', 'link-6');">type</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-23', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-24', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-25', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-26', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-27" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-27', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-28', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-29', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-30" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-30', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-31', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt id="link-32" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-32', 'type', 'link-6');">type</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterAllCallbacks"></a><div id="Plugin.unregisterAllCallbacks-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="Plugin.unregisterAllCallbacks-toggle" onclick="return toggle('Plugin.unregisterAllCallbacks');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterAllCallbacks">unregisterAllCallbacks</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterAllCallbacks-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterAllCallbacks-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">        Method to unregister all callbacks.</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">callbacktype</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-33', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">:</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">            <tt class="py-name">callbacklist</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="plugins.pluginclass.Plugin.callbacks" class="py-name" href="#" onclick="return doclink('link-34', 'callbacks', 'link-0');">callbacks</a></tt><tt class="py-op">[</tt><tt class="py-name">callbacktype</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">callbacklist</tt><tt class="py-op">:</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterCallback()=plugins.pluginclass.Plugin-class.html#unregisterCallback"><a title="plugins.pluginclass.Plugin.unregisterCallback" class="py-name" href="#" onclick="return doclink('link-35', 'unregisterCallback', 'link-35');">unregisterCallback</a></tt><tt class="py-op">(</tt><tt class="py-name">callbacktype</tt><tt class="py-op">,</tt> <tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
</div><a name="Plugin.registerChatCommand"></a><div id="Plugin.registerChatCommand-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="Plugin.registerChatCommand-toggle" onclick="return toggle('Plugin.registerChatCommand');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#registerChatCommand">registerChatCommand</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.registerChatCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.registerChatCommand-expanded"><a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">        Method to register a chatcommand.</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">        @type   command: string</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring">        @param  command: the command name</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">        @type  callback: function</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">        @param callback: The callback</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          boolean</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if it was added</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:  plugin.client must not be none</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:  the command must not already be registered</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-36', 'client', 'link-3');">client</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-37" class="py-name" targets="Variable openttd.client.DataPacket.command=openttd.client.DataPacket-class.html#command"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-37', 'command', 'link-37');">command</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-38', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-39', 'commands', 'link-1');">commands</a></tt><tt class="py-op">:</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-40', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-41', 'commands', 'link-1');">commands</a></tt><tt class="py-op">[</tt><tt id="link-42" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-42', 'command', 'link-37');">command</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-43', 'commands', 'link-1');">commands</a></tt><tt class="py-op">[</tt><tt id="link-44" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-44', 'command', 'link-37');">command</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterChatCommand"></a><div id="Plugin.unregisterChatCommand-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="Plugin.unregisterChatCommand-toggle" onclick="return toggle('Plugin.unregisterChatCommand');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterChatCommand">unregisterChatCommand</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterChatCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterChatCommand-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">        Method to register a chatcommand.</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">        @type   command: string</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">        @param  command: the command name</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          boolean</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if it was removed</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:   plugin.client must not be none</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:   the command must be registered</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-45', 'client', 'link-3');">client</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-46" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-46', 'command', 'link-37');">command</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-47', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-48', 'commands', 'link-1');">commands</a></tt> <tt class="py-keyword">and</tt> <tt id="link-49" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-49', 'command', 'link-37');">command</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-50', 'commands', 'link-1');">commands</a></tt><tt class="py-op">:</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">            <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="openttd.client" class="py-name" href="#" onclick="return doclink('link-51', 'client', 'link-3');">client</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-52', 'commands', 'link-1');">commands</a></tt><tt class="py-op">[</tt><tt id="link-53" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-53', 'command', 'link-37');">command</a></tt><tt class="py-op">]</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">            <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-54', 'commands', 'link-1');">commands</a></tt><tt class="py-op">[</tt><tt id="link-55" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-55', 'command', 'link-37');">command</a></tt><tt class="py-op">]</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterAllChatCommands"></a><div id="Plugin.unregisterAllChatCommands-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="Plugin.unregisterAllChatCommands-toggle" onclick="return toggle('Plugin.unregisterAllChatCommands');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterAllChatCommands">unregisterAllChatCommands</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterAllChatCommands-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterAllChatCommands-expanded"><a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">        Method to unregister all chatcommands.</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">        <tt class="py-name">commandlist</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="plugins.pluginclass.Plugin.commands" class="py-name" href="#" onclick="return doclink('link-56', 'commands', 'link-1');">commands</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt id="link-57" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-57', 'command', 'link-37');">command</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">commandlist</tt><tt class="py-op">:</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterChatCommand()=plugins.pluginclass.Plugin-class.html#unregisterChatCommand"><a title="plugins.pluginclass.Plugin.unregisterChatCommand" class="py-name" href="#" onclick="return doclink('link-58', 'unregisterChatCommand', 'link-58');">unregisterChatCommand</a></tt><tt class="py-op">(</tt><tt id="link-59" class="py-name"><a title="openttd.client.DataPacket.command" class="py-name" href="#" onclick="return doclink('link-59', 'command', 'link-37');">command</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="Plugin.registerEventDispatcher"></a><div id="Plugin.registerEventDispatcher-def"><a name="L115"></a><tt class="py-lineno">115</tt> <a class="py-toggle" href="#" id="Plugin.registerEventDispatcher-toggle" onclick="return toggle('Plugin.registerEventDispatcher');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#registerEventDispatcher">registerEventDispatcher</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">toevent</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.registerEventDispatcher-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.registerEventDispatcher-expanded"><a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">        Method to add an event dispatcher.</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">        Event dispatchers are called when an event is received.</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">        @type   toevent: Event-derived class</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">        @param  toevent: The class where the dispatcher should be added to</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">        @type  callback: function</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">        @param callback: The callback</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          boolean</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if it was registered</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:   the callback must not already be registered</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">toevent</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name" targets="Variable ottd_client_event.Broadcast.dispatchTo=ottd_client_event.Broadcast-class.html#dispatchTo,Variable ottd_client_event.Event.dispatchTo=ottd_client_event.Event-class.html#dispatchTo,Variable ottd_client_event.IRCChat.dispatchTo=ottd_client_event.IRCChat-class.html#dispatchTo,Variable ottd_client_event.IRCPrivateActionChat.dispatchTo=ottd_client_event.IRCPrivateActionChat-class.html#dispatchTo,Variable ottd_client_event.IRCPrivateChat.dispatchTo=ottd_client_event.IRCPrivateChat-class.html#dispatchTo,Variable ottd_client_event.IRCPrivateChatResponse.dispatchTo=ottd_client_event.IRCPrivateChatResponse-class.html#dispatchTo,Variable ottd_client_event.IRCPublicActionChat.dispatchTo=ottd_client_event.IRCPublicActionChat-class.html#dispatchTo,Variable ottd_client_event.IRCPublicChat.dispatchTo=ottd_client_event.IRCPublicChat-class.html#dispatchTo,Variable ottd_client_event.IRCPublicChatResponse.dispatchTo=ottd_client_event.IRCPublicChatResponse-class.html#dispatchTo,Variable ottd_client_event.IRCToIngame.dispatchTo=ottd_client_event.IRCToIngame-class.html#dispatchTo,Variable ottd_client_event.IngameChat.dispatchTo=ottd_client_event.IngameChat-class.html#dispatchTo,Variable ottd_client_event.IngameChatResponse.dispatchTo=ottd_client_event.IngameChatResponse-class.html#dispatchTo,Variable ottd_client_event.IngameToIRC.dispatchTo=ottd_client_event.IngameToIRC-class.html#dispatchTo,Variable ottd_client_event.InternalCommand.dispatchTo=ottd_client_event.InternalCommand-class.html#dispatchTo"><a title="ottd_client_event.Broadcast.dispatchTo
ottd_client_event.Event.dispatchTo
ottd_client_event.IRCChat.dispatchTo
ottd_client_event.IRCPrivateActionChat.dispatchTo
ottd_client_event.IRCPrivateChat.dispatchTo
ottd_client_event.IRCPrivateChatResponse.dispatchTo
ottd_client_event.IRCPublicActionChat.dispatchTo
ottd_client_event.IRCPublicChat.dispatchTo
ottd_client_event.IRCPublicChatResponse.dispatchTo
ottd_client_event.IRCToIngame.dispatchTo
ottd_client_event.IngameChat.dispatchTo
ottd_client_event.IngameChatResponse.dispatchTo
ottd_client_event.IngameToIRC.dispatchTo
ottd_client_event.InternalCommand.dispatchTo" class="py-name" href="#" onclick="return doclink('link-60', 'dispatchTo', 'link-60');">dispatchTo</a></tt><tt class="py-op">:</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line">            <tt class="py-name">toevent</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="ottd_client_event.Broadcast.dispatchTo
ottd_client_event.Event.dispatchTo
ottd_client_event.IRCChat.dispatchTo
ottd_client_event.IRCPrivateActionChat.dispatchTo
ottd_client_event.IRCPrivateChat.dispatchTo
ottd_client_event.IRCPrivateChatResponse.dispatchTo
ottd_client_event.IRCPublicActionChat.dispatchTo
ottd_client_event.IRCPublicChat.dispatchTo
ottd_client_event.IRCPublicChatResponse.dispatchTo
ottd_client_event.IRCToIngame.dispatchTo
ottd_client_event.IngameChat.dispatchTo
ottd_client_event.IngameChatResponse.dispatchTo
ottd_client_event.IngameToIRC.dispatchTo
ottd_client_event.InternalCommand.dispatchTo" class="py-name" href="#" onclick="return doclink('link-61', 'dispatchTo', 'link-60');">dispatchTo</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">toevent</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-62', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">:</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-63', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">[</tt><tt class="py-name">toevent</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-64', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">[</tt><tt class="py-name">toevent</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterEventDispatcher"></a><div id="Plugin.unregisterEventDispatcher-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="Plugin.unregisterEventDispatcher-toggle" onclick="return toggle('Plugin.unregisterEventDispatcher');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterEventDispatcher">unregisterEventDispatcher</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">toevent</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterEventDispatcher-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterEventDispatcher-expanded"><a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">        Method to remove an event dispatcher.</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">        @type   toevent: Event-derived class</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">        @param  toevent: The class where the dispatcher should be added to</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">        @type  callback: function</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">        @param callback: The callback</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype:          boolean</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">        @return:         True if it was unregistered</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">        @precondition:   the callback must be registered</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">toevent</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="ottd_client_event.Broadcast.dispatchTo
ottd_client_event.Event.dispatchTo
ottd_client_event.IRCChat.dispatchTo
ottd_client_event.IRCPrivateActionChat.dispatchTo
ottd_client_event.IRCPrivateChat.dispatchTo
ottd_client_event.IRCPrivateChatResponse.dispatchTo
ottd_client_event.IRCPublicActionChat.dispatchTo
ottd_client_event.IRCPublicChat.dispatchTo
ottd_client_event.IRCPublicChatResponse.dispatchTo
ottd_client_event.IRCToIngame.dispatchTo
ottd_client_event.IngameChat.dispatchTo
ottd_client_event.IngameChatResponse.dispatchTo
ottd_client_event.IngameToIRC.dispatchTo
ottd_client_event.InternalCommand.dispatchTo" class="py-name" href="#" onclick="return doclink('link-65', 'dispatchTo', 'link-60');">dispatchTo</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-66', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">[</tt><tt class="py-name">toevent</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">            <tt class="py-name">toevent</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="ottd_client_event.Broadcast.dispatchTo
ottd_client_event.Event.dispatchTo
ottd_client_event.IRCChat.dispatchTo
ottd_client_event.IRCPrivateActionChat.dispatchTo
ottd_client_event.IRCPrivateChat.dispatchTo
ottd_client_event.IRCPrivateChatResponse.dispatchTo
ottd_client_event.IRCPublicActionChat.dispatchTo
ottd_client_event.IRCPublicChat.dispatchTo
ottd_client_event.IRCPublicChatResponse.dispatchTo
ottd_client_event.IRCToIngame.dispatchTo
ottd_client_event.IngameChat.dispatchTo
ottd_client_event.IngameChatResponse.dispatchTo
ottd_client_event.IngameToIRC.dispatchTo
ottd_client_event.InternalCommand.dispatchTo" class="py-name" href="#" onclick="return doclink('link-67', 'dispatchTo', 'link-60');">dispatchTo</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-68', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">[</tt><tt class="py-name">toevent</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="Plugin.unregisterAllEventDispatchers"></a><div id="Plugin.unregisterAllEventDispatchers-def"><a name="L152"></a><tt class="py-lineno">152</tt> <a class="py-toggle" href="#" id="Plugin.unregisterAllEventDispatchers-toggle" onclick="return toggle('Plugin.unregisterAllEventDispatchers');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterAllEventDispatchers">unregisterAllEventDispatchers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterAllEventDispatchers-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterAllEventDispatchers-expanded"><a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"><tt class="py-docstring">        Method to unregister all event dispatchers</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">dispatcher</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-69', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">:</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">            <tt class="py-name">thisdispatcher</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="plugins.pluginclass.Plugin.dispatchers" class="py-name" href="#" onclick="return doclink('link-70', 'dispatchers', 'link-2');">dispatchers</a></tt><tt class="py-op">[</tt><tt class="py-name">dispatcher</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">dispatchto</tt> <tt class="py-keyword">in</tt> <tt class="py-name">thisdispatcher</tt><tt class="py-op">:</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">                <tt id="link-71" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterEventDispatcher()=plugins.pluginclass.Plugin-class.html#unregisterEventDispatcher"><a title="plugins.pluginclass.Plugin.unregisterEventDispatcher" class="py-name" href="#" onclick="return doclink('link-71', 'unregisterEventDispatcher', 'link-71');">unregisterEventDispatcher</a></tt><tt class="py-op">(</tt><tt class="py-name">dispatcher</tt><tt class="py-op">,</tt> <tt class="py-name">dispatchto</tt><tt class="py-op">)</tt> </tt>
</div><a name="Plugin.unregisterEveryThing"></a><div id="Plugin.unregisterEveryThing-def"><a name="L160"></a><tt class="py-lineno">160</tt> <a class="py-toggle" href="#" id="Plugin.unregisterEveryThing-toggle" onclick="return toggle('Plugin.unregisterEveryThing');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="plugins.pluginclass.Plugin-class.html#unregisterEveryThing">unregisterEveryThing</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Plugin.unregisterEveryThing-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Plugin.unregisterEveryThing-expanded"><a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"><tt class="py-docstring">        Method to unregister everything that was ever registered by the plugin</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterAllCallbacks()=plugins.pluginclass.Plugin-class.html#unregisterAllCallbacks"><a title="plugins.pluginclass.Plugin.unregisterAllCallbacks" class="py-name" href="#" onclick="return doclink('link-72', 'unregisterAllCallbacks', 'link-72');">unregisterAllCallbacks</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterAllChatCommands()=plugins.pluginclass.Plugin-class.html#unregisterAllChatCommands"><a title="plugins.pluginclass.Plugin.unregisterAllChatCommands" class="py-name" href="#" onclick="return doclink('link-73', 'unregisterAllChatCommands', 'link-73');">unregisterAllChatCommands</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name" targets="Method plugins.pluginclass.Plugin.unregisterAllEventDispatchers()=plugins.pluginclass.Plugin-class.html#unregisterAllEventDispatchers"><a title="plugins.pluginclass.Plugin.unregisterAllEventDispatchers" class="py-name" href="#" onclick="return doclink('link-74', 'unregisterAllEventDispatchers', 'link-74');">unregisterAllEventDispatchers</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Oct 20 13:03:13 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
